gdk: Improve GdkTimeCoord docs
authorMatthias Clasen <mclasen@redhat.com>
Mon, 6 Jun 2022 12:55:51 +0000 (08:55 -0400)
committerMatthias Clasen <mclasen@redhat.com>
Mon, 6 Jun 2022 12:55:51 +0000 (08:55 -0400)
gdk/gdkdevice.h

index cf329499a4168cbf1ae2358c269c72146ca828e4..c24c0846318b5c246356d6482dcc8b0acac72114 100644 (file)
@@ -66,10 +66,15 @@ typedef enum
 /**
  * GdkTimeCoord:
  * @time: The timestamp for this event
- * @flags: Flags indicating what axes are present
- * @axes: (array fixed-size=12): axis values
+ * @flags: Flags indicating what axes are present, see [flags@Gdk.AxisFlags]
+ * @axes: (array fixed-size=12): axis values, indexed by [enum@Gdk.AxisUse]
  *
  * A `GdkTimeCoord` stores a single event in a motion history.
+ *
+ * To check whether an axis is present, check whether the corresponding
+ * flag from the [flags@Gdk.AxisFlags] enumeration is set in the @flags
+ * To access individual axis values, use the values of the values of
+ * the [enum@Gdk.AxisUse] enumerations as indices.
  */
 struct _GdkTimeCoord
 {